Skip to content

fix UPS rest api error handling #40111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: 2.4-develop
Choose a base branch
from
Open

fix UPS rest api error handling #40111

wants to merge 1 commit into from

Conversation

fsw
Copy link
Member

@fsw fsw commented Jul 29, 2025

Description (*)

prevent $debugData['result'] to be set to empty string in case of http exception.

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

@fsw
fix UPS rest api error handling
5c1863a 
prevent $debugData['result'] to be set to empty string in case of api errors.
@m2-assistant M2 Assistant
Copy link

m2-assistant bot commented Jul 29, 2025

Hi @fsw. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

lbajsarowicz
lbajsarowicz suggested changes Aug 4, 2025
View reviewed changes
Copy link
Contributor

@lbajsarowicz lbajsarowicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Although your Pull Request is a move towards the right direction, I'd rather change the details of implementation.

  • Bonus idea for improvement (I don't think you should squeeze this into this Pull Request, as these changes to the logger might need additional approvement from Adobe team)

app/code/Magento/Ups/Model/Carrier.php
@@ -1200,10 +1200,10 @@ function () use ($httpResponse, $debugData) {
$debugData['result'] = ['error' => $e->getMessage(), 'code' => $e->getCode()];
$this->_logger->critical($e);
}
if ($responseResult) {
$jsonResponse = $responseResult->getStatusCode() >= 400 ? '' : $responseResult->getBody();
if ($responseResult && ($responseResult->getStatusCode() < 400)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You do not need additional parenthesis.

Suggested change
if ($responseResult && ($responseResult->getStatusCode() < 400)) {
if ($responseResult && $responseResult->getStatusCode() < 400) {

app/code/Magento/Ups/Model/Carrier.php
$jsonResponse = $responseResult->getStatusCode() >= 400 ? '' : $responseResult->getBody();
if ($responseResult && ($responseResult->getStatusCode() < 400)) {
$jsonResponse = $responseResult->getBody();
$debugData['result'] = $jsonResponse;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When it's HTTP 401 / 503 etc. - Your solution does not give any debug information.

app/code/Magento/Ups/Model/Carrier.php
@@ -1200,10 +1200,10 @@ function () use ($httpResponse, $debugData) {
$debugData['result'] = ['error' => $e->getMessage(), 'code' => $e->getCode()];
$this->_logger->critical($e);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could also refactor this logger, as it logs really messy context in the log. Instead, I'd go:

$this->_logger->critical('UPS Exception: ' . $e->getMessage(), [
    'trace' => $e->getTrace(),
    'payload' => $ratePayload
]);

That gives you enough information for debugging and the usage of 2nd argument (array $context) gives you the context of an event.

@github-project-automation github-project-automation bot moved this to Pending Review in Pull Requests Dashboard Aug 5, 2025
@engcom-Hotel engcom-Hotel moved this from Pending Review to Changes Requested in Pull Requests Dashboard Aug 5, 2025
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Changes Requested to Review in Progress in Pull Requests Dashboard Aug 5, 2025
@engcom-Hotel engcom-Hotel moved this from Review in Progress to Changes Requested in Pull Requests Dashboard Aug 5, 2025
@engcom-Hotel engcom-Hotel added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Aug 5, 2025
@engcom-Hotel
Copy link
Contributor

@magenton create issue

@engcom-Hotel engcom-Hotel added the Priority: P3 May be fixed according to the position in the backlog. label Aug 5, 2025
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Changes Requested to Pending Review in Pull Requests Dashboard Aug 5, 2025
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Pending Review to Review in Progress in Pull Requests Dashboard Aug 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lbajsarowicz lbajsarowicz lbajsarowicz requested changes

Assignees
No one assigned
Labels
Priority: P3 May be fixed according to the position in the backlog. Progress: review Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Pull Requests Dashboard
Status: Review in Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fsw @engcom-Hotel @lbajsarowicz